IntelliJ Platform Gradle Plugin/org.jetbrains.intellij.platform.gradle.tasks/InstrumentCodeTask

InstrumentCodeTask

@CacheableTask

abstract class InstrumentCodeTask : DefaultTask, JavaCompilerAware

Task dedicated to executing the code instrumentation using the Ant tasks provided with the currently used IntelliJ Platform dependency.

The code instrumentation scans the compiled Java and Kotlin classes for JetBrains Annotations usages to replace them with relevant functionalities they're responsible for.

This task is controlled with the IntelliJPlatformExtension.instrumentCode extension property, enabled by default. To properly run the instrumentation, it is required to add IntelliJPlatformDependenciesExtension.instrumentationTools dependencies to the project.

This dependency is available via the IntelliJPlatformRepositoriesExtension.intellijDependencies repository, which can be added separately or using the IntelliJPlatformRepositoriesExtension.defaultRepositories helper.

Constructors

InstrumentCodeTask

constructor()

Types

object Companion : Registrable

Properties

@get:Incremental

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val classesDirs: ConfigurableFileCollection

The list of directories with compiled classes.

@get:Internal

var enabled: Boolean

@get:Incremental

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val formsDirs: ConfigurableFileCollection

The list of directories with GUI Designer form files.

hasCustomActions

val hasCustomActions: Boolean

impliesSubProjects

var impliesSubProjects: Boolean

instrumentationLogs

@get:Internal

abstract val instrumentationLogs: Property<Boolean>

Enables INFO logging when running Ant tasks.

javaCompilerConfiguration

@get:Classpath

abstract val javaCompilerConfiguration: ConfigurableFileCollection

Java Compiler configuration.

outputDirectory

@get:OutputDirectory

abstract val outputDirectory: DirectoryProperty

The output directory for instrumented classes.

@get:Internal

abstract val sourceDirs: ConfigurableFileCollection

Location of the source code.

sourceSetCompileClasspath

@get:Internal

abstract val sourceSetCompileClasspath: ConfigurableFileCollection

Compile classpath of the project's source set.

val state: TaskStateInternal

val timeout: Property<Duration>

Functions

acceptServiceReferences

open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>)

appendParallelSafeAction

open override fun appendParallelSafeAction(action: Action<in Task>)

open operator override fun compareTo(other: Task): Int

open override fun configure(closure: Closure<Any>): Task

open override fun dependsOn(vararg paths: Any): Task

open override fun doFirst(action: Closure<Any>): Task

open override fun doFirst(action: Action<in Task>): Task

open override fun doFirst(actionName: String, action: Action<in Task>): Task

open override fun doLast(action: Closure<Any>): Task

open override fun doLast(action: Action<in Task>): Task

open override fun doLast(actionName: String, action: Action<in Task>): Task

doNotTrackState

open override fun doNotTrackState(reasonNotToTrackState: String)

open override fun finalizedBy(vararg paths: Any): Task

open override fun getActions(): MutableList<Action<in Task>>

open override fun getAnt(): AntBuilder

getAsDynamicObject

@Internal

open override fun getAsDynamicObject(): DynamicObject

@Internal

open override fun ~~getConvention~~(): Convention

open override fun getDependsOn(): MutableSet<Any>

open override fun getDescription(): String?

getDestroyables

open override fun getDestroyables(): TaskDestroyables

open override fun getDidWork(): Boolean

open override fun getExtensions(): ExtensionContainer

open override fun getFinalizedBy(): TaskDependency

open override fun getGroup(): String?

getIdentityPath

open override fun getIdentityPath(): Path

open override fun getInputs(): TaskInputsInternal

getLifecycleDependencies

@Internal

open override fun getLifecycleDependencies(): TaskDependencyInternal

open override fun getLocalState(): TaskLocalState

open override fun getLogger(): Logger

open override fun getLogging(): LoggingManager

getMustRunAfter

open override fun getMustRunAfter(): TaskDependency

open override fun getName(): String

open override fun getOnlyIf(): Spec<in TaskInternal>

open override fun getOutputs(): TaskOutputsInternal

open override fun getPath(): String

open override fun getProject(): Project

getReasonNotToTrackState

open override fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open override fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open override fun getRequiredServices(): TaskRequiredServices

getSharedResources

open override fun getSharedResources(): MutableList<ResourceLock>

getShouldRunAfter

open override fun getShouldRunAfter(): TaskDependency

getStandardOutputCapture

open override fun getStandardOutputCapture(): StandardOutputCapture

open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>

getTaskDependencies

open override fun getTaskDependencies(): TaskDependencyInternal

getTaskIdentity

open override fun getTaskIdentity(): TaskIdentity<*>

getTemporaryDir

open override fun getTemporaryDir(): File

getTemporaryDirFactory

open override fun getTemporaryDirFactory(): Factory<File>

open override fun hasProperty(propertyName: String): Boolean

open override fun hasTaskActions(): Boolean

fun instrumentCode(inputChanges: InputChanges): Result<Unit>

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

open override fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(reason: String)

open override fun onlyIf(onlyIfClosure: Closure<Any>)

open override fun onlyIf(spec: Spec<in Task>)

open override fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

prependParallelSafeAction

open override fun prependParallelSafeAction(action: Action<in Task>)

open override fun property(propertyName: String): Any?

open override fun setActions(replacements: MutableList<Action<in Task>>)

open override fun setDependsOn(dependsOn: MutableIterable<*>)

open override fun setDescription(description: String?)

open override fun setDidWork(didWork: Boolean)

open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>)

open override fun setGroup(group: String?)

setMustRunAfter

open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>)

open override fun setOnlyIf(onlyIfClosure: Closure<Any>)

open override fun setOnlyIf(spec: Spec<in Task>)

open override fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

open override fun setProperty(name: String, value: Any)

setShouldRunAfter

open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>)

open override fun shouldRunAfter(vararg paths: Any): TaskDependency

open override fun usesService(service: Provider<out BuildService<*>>)